home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmFrame.z / XmFrame
Encoding:
Text File  |  2003-11-18  |  14.8 KB  |  331 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_F_r_a_m_e - The    Frame widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <Xm/Frame.h>
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.       Frame    is a very simple manager used to enclose a single work
  16.       area child in    a border drawn by Frame.  It uses the Manager
  17.       class    resources for border drawing and performs geometry
  18.       management so    that its size always matches its child's outer
  19.       size plus the    Frame's    margins    and shadow thickness.
  20.  
  21.       Frame    is most    often used to enclose other managers when the
  22.       application developer    desires    the manager to have the    same
  23.       border appearance as the primitive widgets.  Frame can also
  24.       be used to enclose primitive widgets that do not support the
  25.       same type of border drawing.    This gives visual consistency
  26.       when you develop applications    using diverse widget sets.
  27.       Constraint resources are used    to designate a child as    the
  28.       Frame    title, align its text, and control its vertical
  29.       alignment in relation    to Frame's top shadow.    The title
  30.       appears only at the top of the Frame.
  31.  
  32.       If the Frame's parent    is a Shell widget, _X_m_N_s_h_a_d_o_w_T_y_p_e
  33.       defaults to _X_m_S_H_A_D_O_W__O_U_T, and    Manager's resource
  34.       _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s defaults to 1.
  35.  
  36.       If the Frame's parent    is not a Shell widget, _X_m_N_s_h_a_d_o_w_T_y_p_e
  37.       defaults to _X_m_S_H_A_D_O_W__E_T_C_H_E_D__I_N, and Manager's    resource
  38.       _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s defaults to 2.
  39.  
  40.     CCCCllllaaaasssssssseeeessss
  41.       Frame    inherits behavior and resources    from the _C_o_r_e,
  42.       _C_o_m_p_o_s_i_t_e, _C_o_n_s_t_r_a_i_n_t, and _X_m_M_a_n_a_g_e_r classes.
  43.  
  44.       The class pointer is _x_m_F_r_a_m_e_W_i_d_g_e_t_C_l_a_s_s.
  45.  
  46.       The class name is _X_m_F_r_a_m_e.
  47.  
  48.     NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  49.       The following    table defines a    set of widget resources    used
  50.       by the programmer to specify data.  The programmer can also
  51.       set the resource values for the inherited classes to set
  52.       attributes for this widget.  To reference a resource by name
  53.       or by    class in a .Xdefaults file, remove the _X_m_N or _X_m_C
  54.       prefix and use the remaining letters.     To specify one    of the
  55.       defined values for a resource    in a .Xdefaults    file, remove
  56.       the _X_m prefix    and use    the remaining letters (in either
  57.       lowercase or uppercase, but include any underscores between
  58.       words).  The codes in    the access column indicate if the
  59.       given    resource can be    set at creation    time (C), set by using
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       _X_t_S_e_t_V_a_l_u_e_s (S), retrieved by    using _X_t_G_e_t_V_a_l_u_e_s (G), or is
  75.       not applicable (N/A).
  76.  
  77.                  XXXXmmmmFFFFrrrraaaammmmeeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  78.      NNNNaaaammmmeeee           CCCCllllaaaassssssss         TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  79.      ____________________________________________________________________
  80.      XmNmarginWidth    XmCMarginWidth     Dimension     0       CSG
  81.      XmNmarginHeight   XmCMarginHeight     Dimension     0       CSG
  82.      XmNshadowType     XmCShadowType     unsigned char     dynamic   CSG
  83.  
  84.  
  85.       _X_m_N_m_a_r_g_i_n_W_i_d_t_h
  86.            Specifies the padding space on the left and right sides
  87.            between Frame's child and Frame's shadow    drawing.
  88.  
  89.       _X_m_N_m_a_r_g_i_n_H_e_i_g_h_t
  90.            Specifies the padding space on the top and bottom sides
  91.            between Frame's child and Frame's shadow    drawing.  When
  92.            a title is present, the top margin equals the value
  93.            specified by this resource plus the distance (if    any)
  94.            that the    title extends below the    top shadow.
  95.  
  96.       _X_m_N_s_h_a_d_o_w_T_y_p_e
  97.            Describes the drawing style for Frame.  This resource
  98.            can have    the following values:
  99.  
  100.       +o    _X_m_S_H_A_D_O_W__I_N - draws Frame so that it appears inset.
  101.            This means that the bottom shadow visuals and top
  102.            shadow visuals are reversed.
  103.  
  104.       +o    _X_m_S_H_A_D_O_W__O_U_T - draws Frame so that it appears outset.
  105.            This is the default if Frame's parent is    a Shell
  106.            widget.
  107.  
  108.       +o    _X_m_S_H_A_D_O_W__E_T_C_H_E_D__I_N - draws Frame    using a    double line
  109.            giving the effect of a line etched into the window.
  110.            The thickness of    the double line    is equal to the    value
  111.            of _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s.  This is the default when
  112.            Frame's parent is not a Shell widget.
  113.  
  114.       +o    _X_m_S_H_A_D_O_W__E_T_C_H_E_D__O_U_T - draws Frame using a double    line
  115.            giving the effect of a line coming out of the window.
  116.            The thickness of    the double line    is equal to the    value
  117.            of _X_m_N_s_h_a_d_o_w_T_h_i_c_k_n_e_s_s.
  118.  
  119.                        XXXXmmmmFFFFrrrraaaammmmeeee CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  120.      NNNNaaaammmmeeee               CCCCllllaaaassssssss             TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt          AAAAcccccccceeeessssssss
  121.      ___________________________________________________________________________________________________________
  122.      XmNchildType           XmCChildType             unsigned char     XmFRAME_WORKAREA_CHILD      CSG
  123.      XmNchildHorizontalAlignment   XmCChildHorizontalAlignment     unsigned char     XmALIGNMENT_BEGINNING      CSG
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.      XmNchildHorizontalSpacing       XmCChildHorizontalSpacing     Dimension     dynamic          CSG
  141.      XmNchildVerticalAlignment       XmCChildVerticalAlignment     unsigned char     XmALIGNMENT_CENTER      CSG
  142.  
  143.  
  144.       _X_m_N_c_h_i_l_d_T_y_p_e
  145.            Specifies whether a child is a title or work area.
  146.            Frame supports a    single title and/or work area child.
  147.            The possible values are:
  148.  
  149.       +o    _X_m_F_R_A_M_E__T_I_T_L_E__C_H_I_L_D
  150.  
  151.       +o    _X_m_F_R_A_M_E__W_O_R_K_A_R_E_A__C_H_I_L_D
  152.  
  153.       +o    _X_m_F_R_A_M_E__G_E_N_E_R_I_C__C_H_I_L_D
  154.  
  155.       The Frame geometry manager ignores any child of type
  156.       _X_m_F_R_A_M_E__G_E_N_E_R_I_C__C_H_I_L_D.
  157.  
  158.       _X_m_N_c_h_i_l_d_H_o_r_i_z_o_n_t_a_l_A_l_i_g_n_m_e_n_t
  159.            Specifies the alignment of the title.  This resource
  160.            has the following values:
  161.  
  162.       +o    _X_m_A_L_I_G_N_M_E_N_T__B_E_G_I_N_N_I_N_G
  163.  
  164.       +o    _X_m_A_L_I_G_N_M_E_N_T__C_E_N_T_E_R
  165.  
  166.       +o    _X_m_A_L_I_G_N_M_E_N_T__E_N_D
  167.  
  168.       See the description of  _X_m_N_a_l_i_g_n_m_e_n_t in the _X_m_L_a_b_e_l man page
  169.       for an explanation of    these values.
  170.  
  171.       _X_m_N_c_h_i_l_d_H_o_r_i_z_o_n_t_a_l_S_p_a_c_i_n_g
  172.            Specifies the minimum distance between either edge of
  173.            the title text and the inner edge of the    Frame shadow.
  174.            Clipping    of the title text occurs in order to maintain
  175.            this spacing.  The default value    is the margin width of
  176.            the Frame.
  177.  
  178.       _X_m_N_c_h_i_l_d_V_e_r_t_i_c_a_l_A_l_i_g_n_m_e_n_t
  179.            Specifies the vertical alignment    of the title text, or
  180.            the title area in relation to the top shadow of the
  181.            Frame.
  182.  
  183.       +o    _X_m_A_L_I_G_N_M_E_N_T__B_A_S_E_L_I_N_E__B_O_T_T_O_M - causes the    baseline of
  184.            the title to align vertically with the top shadow of
  185.            the Frame.  In the case of a multi-line title, the
  186.            baseline    of the last line of text aligns    vertically
  187.            with the    top shadow of the Frame.
  188.  
  189.       +o    _X_m_A_L_I_G_N_M_E_N_T__B_A_S_E_L_I_N_E__T_O_P    - causes the baseline of the
  190.            first line of the title to align    vertically with    the
  191.            top shadow of the Frame.
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 11/11/03)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  203.  
  204.  
  205.  
  206.       +o    _X_m_A_L_I_G_N_M_E_N_T__W_I_D_G_E_T__T_O_P -    causes the top edge of the
  207.            title area to align vertically with the top shadow of
  208.            the Frame.
  209.  
  210.       +o    _X_m_A_L_I_G_N_M_E_N_T__C_E_N_T_E_R - causes the center of the title
  211.            area to align vertically    with the top shadow of the
  212.            Frame.
  213.  
  214.       +o    _X_m_A_L_I_G_N_M_E_N_T__W_I_D_G_E_T__B_O_T_T_O_M - causes the bottom edge of
  215.            the title area to align vertically with the top shadow
  216.            of the Frame.
  217.  
  218.     IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  219.       Frame    inherits behavior and resources    from the following
  220.       superclasses.     For a complete    description of each resource,
  221.       refer    to the man page    for that superclass.
  222.  
  223.                       XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  224.      NNNNaaaammmmeeee             CCCCllllaaaassssssss             TTTTyyyyppppeeee         DDDDeeeeffffaaaauuuulllltttt        AAAAcccccccceeeessssssss
  225.      _________________________________________________________________________________________________
  226.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel         dynamic        CSG
  227.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap         XmUNSPECIFIED_PIXMAP    CSG
  228.      XmNforeground         XmCForeground         Pixel         dynamic        CSG
  229.      XmNhelpCallback         XmCCallback         XtCallbackList     NULL            C
  230.      XmNhighlightColor         XmCHighlightColor         Pixel         dynamic        CSG
  231.      XmNhighlightPixmap         XmCHighlightPixmap         Pixmap         dynamic        CSG
  232.      XmNinitialFocus         XmCInitialFocus         Widget         NULL            CSG
  233.      XmNnavigationType         XmCNavigationType         XmNavigationType     XmTAB_GROUP        CSG
  234.      XmNshadowThickness         XmCShadowThickness         Dimension         dynamic        CSG
  235.      XmNstringDirection         XmCStringDirection         XmStringDirection     dynamic        CG
  236.      XmNtopShadowColor         XmCTopShadowColor         Pixel         dynamic        CSG
  237.      XmNtopShadowPixmap         XmCTopShadowPixmap         Pixmap         dynamic        CSG
  238.      XmNtraversalOn         XmCTraversalOn         Boolean         True            CSG
  239.      XmNunitType         XmCUnitType         unsigned char     dynamic        CSG
  240.      XmNuserData         XmCUserData         XtPointer         NULL            CSG
  241.  
  242.  
  243.                  CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee    SSSSeeeetttt
  244.      NNNNaaaammmmeeee         CCCCllllaaaassssssss             TTTTyyyyppppeeee       DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  245.      ______________________________________________________________________
  246.      XmNchildren     XmCReadOnly         WidgetList       NULL         G
  247.      XmNinsertPosition     XmCInsertPosition   XtOrderProc   NULL         CSG
  248.      XmNnumChildren     XmCReadOnly         Cardinal       0         G
  249.  
  250.  
  251.                            CCCCoooorrrreeee    RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  252.      NNNNaaaammmmeeee                 CCCCllllaaaassssssss                 TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt             AAAAcccccccceeeessssssss
  253.      ______________________________________________________________________________________________________________
  254.      XmNaccelerators             XmCAccelerators             XtAccelerators   dynamic             CSG
  255.      XmNancestorSensitive         XmCSensitive             Boolean          dynamic             G
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                        (printed 11/11/03)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  269.  
  270.  
  271.  
  272.      XmNbackground             XmCBackground             Pixel          dynamic             CSG
  273.      XmNbackgroundPixmap         XmCPixmap                 Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  274.      XmNborderColor             XmCBorderColor             Pixel          XtDefaultForeground    CSG
  275.      XmNborderPixmap             XmCPixmap                 Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  276.      XmNborderWidth             XmCBorderWidth             Dimension          0                 CSG
  277.      XmNcolormap             XmCColormap             Colormap          dynamic             CG
  278.      XmNdepth                 XmCDepth                 int          dynamic             CG
  279.      XmNdestroyCallback             XmCCallback             XtCallbackList   NULL             C
  280.      XmNheight                 XmCHeight                 Dimension          dynamic             CSG
  281.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True             C
  282.      XmNmappedWhenManaged         XmCMappedWhenManaged         Boolean          True             CSG
  283.      XmNscreen                 XmCScreen                 Screen *          dynamic             CG
  284.      XmNsensitive             XmCSensitive             Boolean          True             CSG
  285.      XmNtranslations             XmCTranslations             XtTranslations   dynamic             CSG
  286.      XmNwidth                 XmCWidth                 Dimension          dynamic             CSG
  287.      XmNx                 XmCPosition             Position          0                 CSG
  288.      XmNy                 XmCPosition             Position          0                 CSG
  289.  
  290.  
  291.     TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  292.       XmFrame inherits translations    from XmManager.
  293.  
  294.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  295.       _C_o_m_p_o_s_i_t_e(_3_X), _C_o_n_s_t_r_a_i_n_t(_3_X), _C_o_r_e(_3_X), _X_m_C_r_e_a_t_e_F_r_a_m_e(_3_X),
  296.       and _X_m_M_a_n_a_g_e_r(_3_X).
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                        (printed 11/11/03)
  328.  
  329.  
  330.  
  331.